docs: Explain 'icon theme context' better in gtkicontheme.c
authorKjell Ahlstedt <kjell.ahlstedt@bredband.net>
Fri, 11 Apr 2014 16:52:39 +0000 (18:52 +0200)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 8 Dec 2014 04:35:31 +0000 (23:35 -0500)
Add links from gtk_icon_theme_list_contexts() to
gtk_icon_theme_list_icons(), and from there to the Icon Theme
Specification and the Icon Naming Specification.

https://bugzilla.gnome.org/show_bug.cgi?id=461249

gtk/gtkicontheme.c

index 2591086967555f12e782e0fad82917ab1b2440f4..0592d8892278edde1c126997824ca7add818bc4e 100644 (file)
@@ -2543,12 +2543,16 @@ add_key_to_list (gpointer key,
  * @icon_theme: a #GtkIconTheme
  * @context: (allow-none): a string identifying a particular type of
  *           icon, or %NULL to list all icons.
- * 
+ *
  * Lists the icons in the current icon theme. Only a subset
  * of the icons can be listed by providing a context string.
  * The set of values for the context string is system dependent,
  * but will typically include such values as “Applications” and
- * “MimeTypes”.
+ * “MimeTypes”. Contexts are explained in the
+ * [Icon Theme Specification](http://www.freedesktop.org/wiki/Specifications/icon-theme-spec).
+ * The standard contexts are listed in the
+ * [Icon Naming Specification](http://www.freedesktop.org/wiki/Specifications/icon-naming-spec).
+ * Also see gtk_icon_theme_list_contexts().
  *
  * Returns: (element-type utf8) (transfer full): a #GList list
  *     holding the names of all the icons in the theme. You must
@@ -2610,7 +2614,8 @@ gtk_icon_theme_list_icons (GtkIconTheme *icon_theme,
  * @icon_theme: a #GtkIconTheme
  *
  * Gets the list of contexts available within the current
- * hierarchy of icon themes
+ * hierarchy of icon themes.
+ * See gtk_icon_theme_list_icons() for details about contexts.
  *
  * Returns: (element-type utf8) (transfer full): a #GList list
  *     holding the names of all the contexts in the theme. You must first